<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: VaadinConfigurable.html 906 2014-07-30 00:09:06Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin7;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Documented;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.lang.annotation.ElementType;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.lang.annotation.Inherited;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.lang.annotation.Retention;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.lang.annotation.RetentionPolicy;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.lang.annotation.Target;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.dellroad.stuff.java.ErrorAction;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.springframework.beans.factory.annotation.Autowire;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Indicates that the class is a candidate for configuration using the {@code VaadinConfigurableAspect} aspect.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Analogous to Spring's {@link org.springframework.beans.factory.annotation.Configurable @Configurable} annotation,<a name="line.24"></a>
<span class="sourceLineNo">025</span> * but causes beans to be autowired into the Spring application context associated with the current<a name="line.25"></a>
<span class="sourceLineNo">026</span> * {@link com.vaadin.server.VaadinSession} (aka "Vaadin application") by {@link SpringVaadinSessionListener} instead of<a name="line.26"></a>
<span class="sourceLineNo">027</span> * the Spring application context associated with the servlet context.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;/p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * For an extra safety check, consider setting {@link org.dellroad.stuff.vaadin7.VaadinConfigurable#ifSessionNotLocked}<a name="line.31"></a>
<span class="sourceLineNo">032</span> * where appropriate.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;/p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * For the this annotation to function properly, {@link VaadinConfigurable @VaadinConfigurable} classes must be woven<a name="line.36"></a>
<span class="sourceLineNo">037</span> * (either at build time or runtime) using the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;a href="http://www.eclipse.org/aspectj/doc/released/faq.php#compiler"&gt;AspectJ compiler&lt;/a&gt; with the<a name="line.38"></a>
<span class="sourceLineNo">039</span> * {@code VaadinConfigurableAspect} aspect (included in the &lt;code&gt;dellroad-stuff&lt;/code&gt; JAR file), and the<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@link SpringVaadinServlet} must be used.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;/p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @see org.dellroad.stuff.vaadin7<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @see SpringVaadinServlet<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @see SpringVaadinSessionListener<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @see &lt;a href="https://github.com/archiecobbs/dellroad-stuff-vaadin-spring-demo3/tree/vaadin7"&gt;Example Code on GitHub&lt;/a&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.48"></a>
<span class="sourceLineNo">049</span>@Target(ElementType.TYPE)<a name="line.49"></a>
<span class="sourceLineNo">050</span>@Documented<a name="line.50"></a>
<span class="sourceLineNo">051</span>@Inherited<a name="line.51"></a>
<span class="sourceLineNo">052</span>public @interface VaadinConfigurable {<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * Configuration bean definition template name, if any.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    String value() default "";<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>    /**<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * Whether and how to automatically autowire dependencies.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    Autowire autowire() default Autowire.NO;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>    /**<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * Whether to enable dependency checking.<a name="line.65"></a>
<span class="sourceLineNo">066</span>     */<a name="line.66"></a>
<span class="sourceLineNo">067</span>    boolean dependencyCheck() default false;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * Whether to inject dependencies prior to constructor execution.<a name="line.70"></a>
<span class="sourceLineNo">071</span>     */<a name="line.71"></a>
<span class="sourceLineNo">072</span>    boolean preConstruction() default false;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    /**<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * What to do when we discover that the {@link com.vaadin.server.VaadinSession} is not<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * {@linkplain com.vaadin.server.VaadinSession#getLockInstance locked} when the annotated bean is constructed.<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * For beans that are (or will interact with) Vaadin widgets, containers, etc., this typically<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * indicates a programming error. In such cases, this property configures what to do, if anything.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @see com.vaadin.server.VaadinSession#getLockInstance<a name="line.80"></a>
<span class="sourceLineNo">081</span>     */<a name="line.81"></a>
<span class="sourceLineNo">082</span>    ErrorAction ifSessionNotLocked() default ErrorAction.EXCEPTION;<a name="line.82"></a>
<span class="sourceLineNo">083</span>}<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>




























































</pre>
</div>
</body>
</html>
